// 版权所有2011 Go作者。版权所有。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// HTTP反向代理处理程序

package httputil

import (
	"context"
	"fmt"
	"io"
	"log"
	"net"
	"net/http"
	"net/http/internal/ascii"
	"net/textproto"
	"net/url"
	"strings"
	"sync"
	"time"

	"golang.org/x/net/http/httpguts"
)

// ReverseProxy是一个HTTP处理程序，它接受传入的请求，并将其发送到另一台服务器，将响应代理回
// 客户端。
// 
// ReverseProxy默认将客户端IP设置为
// X-Forwarded-For头的值。
// 
// 如果已存在X-Forwarded-For标头，则客户端IP将附加到现有值后。作为一种特殊情况，如果Request.header映射中存在头
// 但其值为零（例如当Director func设置
// 时），则X-Forwarded-For头为
// 未修改。
// 
// 为防止IP欺骗，请确保删除任何来自客户端的预先存在的
// X-Forwarded-For头或
// 不受信任的代理。
type ReverseProxy struct {
	// 控制器必须是一个函数，该函数将
	// 请求修改为一个新请求，以便使用传输发送
	// 命令。然后，它的响应将被复制到原始客户端，而不做任何修改。
	// 返回后，控制器不得访问提供的请求
	// 。
	Director func(*http.Request)

	// 用于执行代理请求的传输。
	// 如果为零，则使用http.DefaultTransport。
	Transport http.RoundTripper

	// FlushInterval指定刷新间隔
	// 在复制
	// 响应正文时刷新到客户端。
	// 如果为零，则不进行定期冲洗。
	// 负值表示每次写入客户端后立即刷新
	// 的值。
	// 当ReverseProxy 
	// 将响应识别为流式响应时，忽略FlushInterval；如果响应的内容长度为-1，则忽略
	// ；对于此类响应，写入的
	// 将立即刷新到客户端。
	FlushInterval time.Duration

	// ErrorLog为尝试代理请求时发生的错误
	// 指定可选记录器。
	// 如果为nil，则通过日志包的标准记录器完成日志记录。
	ErrorLog *log.Logger

	// BufferPool可选择指定一个缓冲池，以在复制HTTP响应体时获取io.CopyBuffer使用的字节片。
	BufferPool BufferPool

	// ModifyResponse是一个可选函数，用于从后端修改
	// 响应。如果后端
	// 返回带有任何HTTP状态码的响应，则调用该函数。
	// 如果无法访问后端，则可选的ErrorHandler为
	// 在不调用ModifyResponse的情况下调用。
	// 
	// 如果ModifyResponse返回错误，ErrorHandler将被称为
	// 及其错误值。如果ErrorHandler为nil，则使用其默认的
	// 实现。
	ModifyResponse func(*http.Response) error

	// ErrorHandler是一个可选函数，用于处理错误
	// 到达后端或来自ModifyResponse的错误。
	// 
	// 如果为零，则默认为记录提供的错误并返回
	// 502状态错误网关响应。
	ErrorHandler func(http.ResponseWriter, *http.Request, error)
}

// 缓冲池是获取和返回临时
// 字节片以供io.CopyBuffer使用的接口。
type BufferPool interface {
	Get() []byte
	Put([]byte)
}

func singleJoiningSlash(a, b string) string {
	aslash := strings.HasSuffix(a, "/")
	bslash := strings.HasPrefix(b, "/")
	switch {
	case aslash && bslash:
		return a + b[1:]
	case !aslash && !bslash:
		return a + "/" + b
	}
	return a + b
}

func joinURLPath(a, b *url.URL) (path, rawpath string) {
	if a.RawPath == "" && b.RawPath == "" {
		return singleJoiningSlash(a.Path, b.Path), ""
	}
	// 与SingleJoiningFlash相同，但使用EscapedPath确定
	// 是否应添加斜杠
	apath := a.EscapedPath()
	bpath := b.EscapedPath()

	aslash := strings.HasSuffix(apath, "/")
	bslash := strings.HasPrefix(bpath, "/")

	switch {
	case aslash && bslash:
		return a.Path + b.Path[1:], apath + bpath[1:]
	case !aslash && !bslash:
		return a.Path + "/" + b.Path, apath + "/" + bpath
	}
	return a.Path + b.Path, apath + bpath
}

// NewSingleHostReverseProxy返回一个新的ReverseProxy，将
// URL路由到目标中提供的方案、主机和基本路径。如果
// 目标路径为“/base”，传入请求为“/dir”，则
// 目标请求为/base/dir。
// NewSingleHostReverseProxy不会重写主机头。
// 若要重写主机头，请直接将ReverseProxy与自定义
// 控制器策略一起使用。
func NewSingleHostReverseProxy(target *url.URL) *ReverseProxy {
	targetQuery := target.RawQuery
	director := func(req *http.Request) {
		req.URL.Scheme = target.Scheme
		req.URL.Host = target.Host
		req.URL.Path, req.URL.RawPath = joinURLPath(target, req.URL)
		if targetQuery == "" || req.URL.RawQuery == "" {
			req.URL.RawQuery = targetQuery + req.URL.RawQuery
		} else {
			req.URL.RawQuery = targetQuery + "&" + req.URL.RawQuery
		}
		if _, ok := req.Header["User-Agent"]; !ok {
			// 显式禁用用户代理，因此不会将其设置为默认值
			req.Header.Set("User-Agent", "")
		}
	}
	return &ReverseProxy{Director: director}
}

func copyHeader(dst, src http.Header) {
	for k, vv := range src {
		for _, v := range vv {
			dst.Add(k, v)
		}
	}
}

// 逐跳标头。当发送到后端时，这些将被删除。
// 从RFC 7230开始，需要在
// 连接头字段中显示逐跳头。这些是
// 淘汰的RFC 2616（第13.5.1节）定义的标题，用于向后
// 兼容性。
var hopHeaders = []string{
	"Connection",
	"Proxy-Connection", // 非标准，但仍由libcurl发送，并被谷歌等拒绝
	"Keep-Alive",
	"Proxy-Authenticate",
	"Proxy-Authorization",
	"Te",      // 规范化版本的“TE”
	"Trailer", // 不是上述每个URL的预告片；https:
	"Transfer-Encoding",
	"Upgrade",
}

func (p *ReverseProxy) defaultErrorHandler(rw http.ResponseWriter, req *http.Request, err error) {
	p.logf("http: proxy error: %v", err)
	rw.WriteHeader(http.StatusBadGateway)
}

func (p *ReverseProxy) getErrorHandler() func(http.ResponseWriter, *http.Request, error) {
	if p.ErrorHandler != nil {
		return p.ErrorHandler
	}
	return p.defaultErrorHandler
}

// modifyResponse有条件地运行可选的modifyResponse钩子
// 并报告请求是否应继续。
func (p *ReverseProxy) modifyResponse(rw http.ResponseWriter, res *http.Response, req *http.Request) bool {
	if p.ModifyResponse == nil {
		return true
	}
	if err := p.ModifyResponse(res); err != nil {
		res.Body.Close()
		p.getErrorHandler()(rw, req, err)
		return false
	}
	return true
}

func (p *ReverseProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
	transport := p.Transport
	if transport == nil {
		transport = http.DefaultTransport
	}

	ctx := req.Context()
	if cn, ok := rw.(http.CloseNotifier); ok {
		var cancel context.CancelFunc
		ctx, cancel = context.WithCancel(ctx)
		defer cancel()
		notifyChan := cn.CloseNotify()
		go func() {
			select {
			case <-notifyChan:
				cancel()
			case <-ctx.Done():
			}
		}()
	}

	outreq := req.Clone(ctx)
	if req.ContentLength == 0 {
		outreq.Body = nil // 问题16036:http的无正文。传输重试
	}
	if outreq.Body != nil {
		// 从处理程序返回后读取请求正文是不允许的
		// 并且读取正文的往返goroutine可能比
		// 此处理程序更有效。如果处理程序惊慌失措，这可能导致崩溃（请参阅
		// 第46866期）。虽然调用Close并不保证句柄返回后不会有任何读取，但实际上关闭句柄后读取是安全的。
		defer outreq.Body.Close()
	}
	if outreq.Header == nil {
		outreq.Header = make(http.Header) // 问题33142:历史行为是始终将
	}

	p.Director(outreq)
	outreq.Close = false

	reqUpType := upgradeType(outreq.Header)
	if !ascii.IsPrint(reqUpType) {
		p.getErrorHandler()(rw, req, fmt.Errorf("client tried to switch to invalid protocol %q", reqUpType))
		return
	}
	removeConnectionHeaders(outreq.Header)

	// 逐跳删除头分配到后端。尤其是
	// 重要的是“连接”，因为我们需要一个持久的
	// 连接，而不管客户端发送给我们什么。
	for _, h := range hopHeaders {
		outreq.Header.Del(h)
	}

	// 问题21096：告诉关心拖车支持的后端应用程序
	// 我们支持拖车。（我们是这样做的，但我们不会特意去宣传，除非传入的客户端请求认为值得一提。）注意，我们看的是req.Header，而不是outreq.Header，因为后者已经通过RemoveConnectionHeader。
	if httpguts.HeaderValuesContainsToken(req.Header["Te"], "trailers") {
		outreq.Header.Set("Te", "trailers")
	}

	// 在剥离上述所有逐跳连接头后，添加回协议升级（如WebSocket）所需的所有
	// 连接头。
	if reqUpType != "" {
		outreq.Header.Set("Connection", "Upgrade")
		outreq.Header.Set("Upgrade", reqUpType)
	}

	if clientIP, _, err := net.SplitHostPort(req.RemoteAddr); err == nil {
		// 如果我们不是第一个代理，请保留先前的
		// X-Forwarded-以逗号+空格的形式提供信息
		// 分隔列表并将多个标题折叠为一个。
		prior, ok := outreq.Header["X-Forwarded-For"]
		omit := ok && prior == nil // 问题38079:nil现在表示不填充头
		if len(prior) > 0 {
			clientIP = strings.Join(prior, ", ") + ", " + clientIP
		}
		if !omit {
			outreq.Header.Set("X-Forwarded-For", clientIP)
		}
	}

	res, err := transport.RoundTrip(outreq)
	if err != nil {
		p.getErrorHandler()(rw, outreq, err)
		return
	}

	// 处理101个交换协议响应：（WebSocket、h2c等）
	if res.StatusCode == http.StatusSwitchingProtocols {
		if !p.modifyResponse(rw, res, outreq) {
			return
		}
		p.handleUpgradeResponse(rw, outreq, res)
		return
	}

	removeConnectionHeaders(res.Header)

	for _, h := range hopHeaders {
		res.Header.Del(h)
	}

	if !p.modifyResponse(rw, res, outreq) {
		return
	}

	copyHeader(rw.Header(), res.Header)

	// 传输的响应中不包含“拖车”头，
	// 至少对于*http.Transport。从拖车上组装起来。
	announcedTrailers := len(res.Trailer)
	if announcedTrailers > 0 {
		trailerKeys := make([]string, 0, len(res.Trailer))
		for k := range res.Trailer {
			trailerKeys = append(trailerKeys, k)
		}
		rw.Header().Add("Trailer", strings.Join(trailerKeys, ", "))
	}

	rw.WriteHeader(res.StatusCode)

	err = p.copyResponse(rw, res.Body, p.flushInterval(res))
	if err != nil {
		defer res.Body.Close()
		// 因为我们正在流式传输响应，如果遇到错误，我们所能做的就是中止请求。问题23643:ReverseProxy应在复制正文时对读取错误使用勘误表
		// 。
		if !shouldPanicOnCopyError(req) {
			p.logf("suppressing panic for copyResponse error in test; copy error: %v", err)
			return
		}
		panic(http.ErrAbortHandler)
	}
	res.Body.Close() // 立即关闭，而不是延迟，以填充res.Trailer 

	if len(res.Trailer) > 0 {
		// 如果我们看到响应预告片，则强制分块。
		// 这将阻止net/http计算短体的长度并添加内容长度。
		if fl, ok := rw.(http.Flusher); ok {
			fl.Flush()
		}
	}

	if len(res.Trailer) == announcedTrailers {
		copyHeader(rw.Header(), res.Trailer)
		return
	}

	for k, vv := range res.Trailer {
		k = http.TrailerPrefix + k
		for _, v := range vv {
			rw.Header().Add(k, v)
		}
	}
}

var inOurTests bool // 我们是否在自己的测试中

// shouldPanicOnCopyError报告反向代理是否应该
// 对http.ErrAbortHandler感到恐慌。默认情况下，这是
// 应该做的事情，但是Go 1.10和更早版本没有这样做，所以现有的单元测试
// 没有预料到恐慌。只有在我们自己的测试中，或者在HTTP服务器下运行
// 时才会出现恐慌。
func shouldPanicOnCopyError(req *http.Request) bool {
	if inOurTests {
		// 我们的测试知道如何应对这种恐慌。
		return true
	}
	if req.Context().Value(http.ServerContextKey) != nil {
		// 我们似乎在HTTP服务器下运行，所以
		// 它将恢复恐慌。
		return true
	}
	// 否则，像Go 1.10或更早版本一样，不会破坏现有测试。
	return false
}

// removeConnectionHeaders删除h的“连接”头中列出的逐跳头。
// 请参阅RFC 7230第6.1节
func removeConnectionHeaders(h http.Header) {
	for _, f := range h["Connection"] {
		for _, sf := range strings.Split(f, ",") {
			if sf = textproto.TrimString(sf); sf != "" {
				h.Del(sf)
			}
		}
	}
}

// flushInterval返回p.flushInterval值，有条件地
// 覆盖特定请求/响应的值。
func (p *ReverseProxy) flushInterval(res *http.Response) time.Duration {
	resCT := res.Header.Get("Content-Type")

	// 对于服务器发送的事件响应，请立即刷新。
	// MIME类型是在https中定义的：
	if resCT == "text/event-stream" {
		return -1 // 否定表示立即
	}

	// 我们可能会遇到无法设置内容长度的流式传输的情况。
	if res.ContentLength == -1 {
		return -1
	}

	return p.FlushInterval
}

func (p *ReverseProxy) copyResponse(dst io.Writer, src io.Reader, flushInterval time.Duration) error {
	if flushInterval != 0 {
		if wf, ok := dst.(writeFlusher); ok {
			mlw := &maxLatencyWriter{
				dst:     wf,
				latency: flushInterval,
			}
			defer mlw.stop()

			// 设置初始计时器，以便即使主体写入被延迟，也会刷新头
			mlw.flushPending = true
			mlw.t = time.AfterFunc(flushInterval, mlw.delayedFlush)

			dst = mlw
		}
	}

	var buf []byte
	if p.BufferPool != nil {
		buf = p.BufferPool.Get()
		defer p.BufferPool.Put(buf)
	}
	_, err := p.copyBuffer(dst, src, buf)
	return err
}

// copyBuffer返回任何写入错误或非EOF读取错误，以及写入的字节数
// 。
func (p *ReverseProxy) copyBuffer(dst io.Writer, src io.Reader, buf []byte) (int64, error) {
	if len(buf) == 0 {
		buf = make([]byte, 32*1024)
	}
	var written int64
	for {
		nr, rerr := src.Read(buf)
		if rerr != nil && rerr != io.EOF && rerr != context.Canceled {
			p.logf("httputil: ReverseProxy read error during body copy: %v", rerr)
		}
		if nr > 0 {
			nw, werr := dst.Write(buf[:nr])
			if nw > 0 {
				written += int64(nw)
			}
			if werr != nil {
				return written, werr
			}
			if nr != nw {
				return written, io.ErrShortWrite
			}
		}
		if rerr != nil {
			if rerr == io.EOF {
				rerr = nil
			}
			return written, rerr
		}
	}
}

func (p *ReverseProxy) logf(format string, args ...interface{}) {
	if p.ErrorLog != nil {
		p.ErrorLog.Printf(format, args...)
	} else {
		log.Printf(format, args...)
	}
}

type writeFlusher interface {
	io.Writer
	http.Flusher
}

type maxLatencyWriter struct {
	dst     writeFlusher
	latency time.Duration // 非零；负表示立即刷新

	mu           sync.Mutex // 保护t、flushPending和dst。刷新
	t            *time.Timer
	flushPending bool
}

func (m *maxLatencyWriter) Write(p []byte) (n int, err error) {
	m.mu.Lock()
	defer m.mu.Unlock()
	n, err = m.dst.Write(p)
	if m.latency < 0 {
		m.dst.Flush()
		return
	}
	if m.flushPending {
		return
	}
	if m.t == nil {
		m.t = time.AfterFunc(m.latency, m.delayedFlush)
	} else {
		m.t.Reset(m.latency)
	}
	m.flushPending = true
	return
}

func (m *maxLatencyWriter) delayedFlush() {
	m.mu.Lock()
	defer m.mu.Unlock()
	if !m.flushPending { // 如果调用了stop，但FUNC已启动此GOROUTE 
		return
	}
	m.dst.Flush()
	m.flushPending = false
}

func (m *maxLatencyWriter) stop() {
	m.mu.Lock()
	defer m.mu.Unlock()
	m.flushPending = false
	if m.t != nil {
		m.t.Stop()
	}
}

func upgradeType(h http.Header) string {
	if !httpguts.HeaderValuesContainsToken(h["Connection"], "Upgrade") {
		return ""
	}
	return h.Get("Upgrade")
}

func (p *ReverseProxy) handleUpgradeResponse(rw http.ResponseWriter, req *http.Request, res *http.Response) {
	reqUpType := upgradeType(req.Header)
	resUpType := upgradeType(res.Header)
	if !ascii.IsPrint(resUpType) { // 我们知道REQUEPTYPE是ASCII，它由调用方检查。
		p.getErrorHandler()(rw, req, fmt.Errorf("backend tried to switch to invalid protocol %q", resUpType))
	}
	if !ascii.EqualFold(reqUpType, resUpType) {
		p.getErrorHandler()(rw, req, fmt.Errorf("backend tried to switch protocol %q when %q was requested", resUpType, reqUpType))
		return
	}

	hj, ok := rw.(http.Hijacker)
	if !ok {
		p.getErrorHandler()(rw, req, fmt.Errorf("can't switch protocols using non-Hijacker ResponseWriter type %T", rw))
		return
	}
	backConn, ok := res.Body.(io.ReadWriteCloser)
	if !ok {
		p.getErrorHandler()(rw, req, fmt.Errorf("internal error: 101 switching protocols response with non-writable body"))
		return
	}

	backConnCloseCh := make(chan bool)
	go func() {
		// 确保取消请求会关闭后端。
		// 请参阅问题https:
		select {
		case <-req.Context().Done():
		case <-backConnCloseCh:
		}
		backConn.Close()
	}()

	defer close(backConnCloseCh)

	conn, brw, err := hj.Hijack()
	if err != nil {
		p.getErrorHandler()(rw, req, fmt.Errorf("Hijack failed on protocol switch: %v", err))
		return
	}
	defer conn.Close()

	copyHeader(rw.Header(), res.Header)

	res.Header = rw.Header()
	res.Body = nil // so res.Write只写入头；我们在backConn中的res.Body位于
	if err := res.Write(brw); err != nil {
		p.getErrorHandler()(rw, req, fmt.Errorf("response write: %v", err))
		return
	}
	if err := brw.Flush(); err != nil {
		p.getErrorHandler()(rw, req, fmt.Errorf("response flush: %v", err))
		return
	}
	errc := make(chan error, 1)
	spc := switchProtocolCopier{user: conn, backend: backConn}
	go spc.copyToBackend(errc)
	go spc.copyFromBackend(errc)
	<-errc
	return
}

// switchProtocolCopier的上方，因此返回代理数据的goroutines和
// forth在堆栈中有很好的名称。
type switchProtocolCopier struct {
	user, backend io.ReadWriter
}

func (c switchProtocolCopier) copyFromBackend(errc chan<- error) {
	_, err := io.Copy(c.user, c.backend)
	errc <- err
}

func (c switchProtocolCopier) copyToBackend(errc chan<- error) {
	_, err := io.Copy(c.backend, c.user)
	errc <- err
}
